/**
 * Copyright 2011 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.solarchallenge.client.rpc;

import com.google.gwt.user.client.rpc.RemoteService;
import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;
import com.google.solarchallenge.shared.ApplicantStatus;
import com.google.solarchallenge.shared.ApplicationDocumentCategory;
import com.google.solarchallenge.shared.ApplicationStatus;
import com.google.solarchallenge.shared.dtos.ApplicantDto;
import com.google.solarchallenge.shared.dtos.ApplicationDto;
import com.google.solarchallenge.shared.dtos.UserAccountDto;

import java.util.ArrayList;

/**
 * GWT RPC for ApplicantService.
 *
 * @author Arjun Satyapal
 */
@RemoteServiceRelativePath("applicantService")
public interface ApplicantService extends RemoteService {
  /**
   * Register a new userAccount.
   *
   * @param userAccountDto : Contact details of the Users.
   * @param applicantDto : Other details of the Applicant.
   */
  void registerApplicant(UserAccountDto userAccountDto,
      ApplicantDto applicantDto);

  /**
   * Get Status of an Applicant using userAccountKey.
   */
  ApplicantStatus getApplicantStatus(String userAccountKey);

  /**
   * Update ApplicantAgreement Status on the server side.
   */
  void updateApplicantAgreementStatus(String userAccountKey,
      boolean isAccepted);

  /**
   * Get new ApplicationId from server.
   */
  String newApplicationId(String applicationDetails);

  /**
   * Attach a new Document with Application.
   */
  void storeUrlWithApplication(ApplicationDocumentCategory docCategory,
      String applicationId, String siteDiagramUrl);

  /**
   * Get complete details for an Application.
   */
  ApplicationDto getApplicationDetails(String applicationId);

  /**
   * Submit an application for review.
   */
  void submitApplication(String applicationId);

  /**
   * Get list of applicaions by Status.
   */
  ArrayList<ApplicationDto> getApplicationsByStatus(
      ApplicationStatus applicationStatus);
}
